home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 6: Level 6 / 17 Bit - Level 6 (1998)(Epic Marketing)[!].iso / quartz / q1171.dms / q1171.adf / IconConvert / IconConvert.doc < prev    next >
Text File  |  1997-04-10  |  10KB  |  306 lines
  1.  
  2.                                IconConvert v1.1
  3.  
  4.                        Copyright ©1995 Peter Liljenberg
  5.  
  6.                          Introduction   What is it -- and why?
  7.                          Installation   Really simple
  8.                          Requirements   An Amiga
  9.                           Legal Stuff   The usual stuff
  10.  
  11.                           General Use   Use the program
  12.                         Workbench Use   Use the mouse
  13.                             Shell Use   Use the keyboard
  14.  
  15.                                  Bugs   Smeg'em
  16.                                 To Do   The future of IconConvert
  17.                       Version History   The past of IconConvert
  18.                 Contacting the Author   Communicate
  19.  
  20.           GUI created with triton.library Copyright © Stefan Zeiger
  21.  
  22.  
  23.     Introduction
  24.  
  25. Icons makes your Amiga more friendly, but finding a set of icons you
  26. actually like is very difficult. Commodore's (RIP) icons are terribly ugly,
  27. the NewIcon system is a good idea but it is slow and it uses a little too
  28. much memory of my precious kilobytes. I had settled on MacigWB's icons, but
  29. I wasn't happy with its demand for an eight colour screen (every kilobyte is
  30. sacred when you only have 2Mb memory.) So I wrote IconConvert to convert
  31. MagicWB's eight colour icons to four colour ones. Now I'm happy.
  32.  
  33. IconConvert's task is to convert the images of icons between different
  34. palettes. You can also use it to strip superfluous image planes from icons,
  35. and thus save space and time when opening drawers in the Workbench.
  36.  
  37. IconConvert converts the icons by changing the colours so that the original
  38. image is kept, even if the new image has fewer image planes or a different
  39. palette.
  40.  
  41.  
  42.     Installation
  43.  
  44. Installation is very simple. Just copy IconConvert wherever you want, and
  45. copy triton.library (in drawer Triton) to LIBS:. You can use the installer
  46. script in the Triton drawer for this.
  47.  
  48.  
  49.     Requirements
  50.  
  51.  * At least OS 2.04+. OS 3.0+ will improve the performance of IconConvert.
  52.  * 100kb of free memory, the more the better.
  53.  
  54.  
  55. IconConvert has been tested on the following setup:
  56.  
  57.     A1200, 020, 2Mb chipmem, 85 Mb hard disk, OS 3.0, with MungWall running.
  58.  
  59.  
  60.     Legal Stuff
  61.  
  62. IconConvert is FreeWare. You can distribute the unmodified archive freely as
  63. long as you don't charge more than a nominal fee, say $5.
  64.  
  65. The author takes no responsibility for any damage or loss of data caused by
  66. use of IconConvert. Use of IconConvert is at the user's own risk.
  67.  
  68.  
  69. IconConvert is Copyright ©1995 Peter Liljenberg. All rights reserved.
  70.  
  71. Triton is Copyright © Stefan Ziegel.
  72.  
  73.  
  74.     General Use
  75.  
  76. You choose one or more icons (files ending with ".info") or directories. You
  77. must also have an in palette and an out palette, either the Workbench screen
  78. palette or a palette from an ILBM file.
  79.  
  80. IconConvert will by default use the Workbench screen palette for both
  81. palettes. Note: If the in palette has fewer colours (smaller image depth)
  82. than the icons you want to convert, IconConvert can't convert correctly
  83. since it won't consider the colours it hasn't information for.
  84.  
  85. Now will IconConvert work out how to convert colours between the palettes,
  86. and then convert all choosen icons and the icons in the choosen directories.
  87. The icons in all subdirectories can also be converted, if specified.
  88.  
  89. The new icons will replace the old, if you don't specify that IconConvert
  90. should backup the originals. If you do, IconConvert will save the old icons
  91. with the extension ".oldinfo".
  92.  
  93.  
  94.     Workbench Use
  95.  
  96. Double click on IconConvert to start. You can choose icons and directories
  97. at the start by clicking once on IconConvert, and then shift click (hold
  98. down shift and click) on icons and drawers, and then double click on the
  99. last icon/drawer to start IconConvert. You can also drop icons and drawers
  100. on the main window -- it's an AppWindow.
  101.  
  102. Now two windows will be opened. The main window and the conversion settings
  103. window.
  104.  
  105.     Main window
  106.     Conversion settings window
  107.     Palette window
  108.     Conversion map window
  109.     Progress window
  110.  
  111.  
  112.     Main Window
  113.  
  114. Gadgets:
  115.  
  116.     Icons   -- A listview gadget showing all choosen icons and dirs. You
  117.                can use the cursor keys to scroll the list.
  118.     Add     -- Click on the button to add icons to icon list. A file
  119.                requester opens where you can choose icons. Shiftclick to
  120.                choose more than one icon.
  121.     Add Dir -- Add a directory to the list. Choose the directory in the
  122.                requester.
  123.     Remove  -- Remove the selected icon/directory from the list.
  124.     Convert -- Start conversion.
  125.  
  126.  
  127. Menus:
  128.  
  129.   Icon:
  130.     Add        -- See above.
  131.     Add Dir    -- See above.
  132.     Remove     -- See above.
  133.     Remove All -- Remove all icons/directories from the list.
  134.     Convert    -- See above.
  135.     About      -- Pop up a requester with some information.
  136.     Quit       -- Quit IconConvert.
  137.  
  138.   Palette:
  139.     Edit In Palette  -- Open in palette window.
  140.     Edit Out Palette -- Open out palette window.
  141.  
  142.  
  143. Clicking on the close gadget will quit IconConvert.
  144.  
  145.  
  146.     Conversion Settings Window
  147.  
  148. Gadgets:
  149.  
  150.     Show Conv. Map -- Show conversion map window before conversion, 
  151.                       allowing you to alter it.
  152.     Enter Subdirs  -- Convert icons in subdirectories to choosen
  153.                       directories.
  154.     Save old icons -- Save the old icons with the extension ".oldinfo",
  155.                       otherwise delete them.
  156.     Depth          -- The image depth of resulting icons.
  157.  
  158.  
  159. Clicking on the close gadget will quit IconConvert.
  160.  
  161.  
  162.     Palette Window
  163.  
  164. Gadgets:
  165.  
  166.     Palette -- A list of all colours in the palette, in the form 
  167.                "n: r, g, b" where n is the colour number, and r, g, and b
  168.                are the red, green and blue values for the colour. You can
  169.                scroll in the list with the cursor keys.
  170.     Colour  -- The currently selected colour.
  171.     Red     -- The red value of the selected colour.
  172.     Green   -- The green value...
  173.     Blue    -- The blue value...
  174.  
  175.  
  176. Menu:
  177.  
  178.   Palette:
  179.     Load Palette       -- Load the palette from an ILBM file, which you
  180.                           choose in the file requester.
  181.     Get Screen Palette -- Get the Workbench screen palette.
  182.     Change Depth       -- Change the depth of the palette. A requester is
  183.                           opened. Set the new depth with the slider.
  184.  
  185.  
  186. Clicking on the close gadget will close the palette window.
  187.  
  188.  
  189.     Conversion Map Window
  190.  
  191. Gadgets:
  192.  
  193.     List   -- A list of the conversion map in the form "x -> y" where x is
  194.               the colour in the in palette, and y is the colour in the out
  195.               palette x will be converted to. You can scroll in the list
  196.               with the up and down cursor keys.
  197.     Slider -- With this you can change y. You can use the left and right
  198.               cursor keys to set y.
  199.     OK     -- Your conversion map will be used, and the conversion will
  200.               continue.
  201.     Cancel -- The old conversion map will be used, and the conversion will
  202.               continue.
  203.     Abort Conversion -- Abort the conversion and quit IconConvert.
  204.  
  205.  
  206.     Progress Window
  207.  
  208. Gadgets:
  209.  
  210.     Text box -- Displays the icon which is being converted.
  211.     Progress -- Displays how many icons that has been converted.
  212.     Cancel   -- Abort conversion and quit IconConvert.
  213.  
  214.  
  215.     Shell Use
  216.  
  217. The argument template:
  218.  
  219. ICON/M,INPAL=INPALETTEFILE/K,OUTPAL=OUTPALETTEFILE/K,DEPTH/N,ALL/S,
  220. SAVEOLD/S,QUIET/S,GUI/S
  221.  
  222.  ICON    -- Icons and directories with icons to be converted.
  223.  INPAL   -- Load this ILBM file's palette as in palette. If not specified
  224.             use the Workbench screen palette.
  225.  OUTPAL  -- Load this ILBM file's palette as out palette. If not specified
  226.             use the Workbench screen palette.
  227.  DEPTH   -- The resulting icons' image depth. If not specified use the
  228.             depth of the out palette.
  229.  ALL     -- Convert icons in subdirectories to directories specified with
  230.             ICON.
  231.  SAVEOLD -- Save the old icons with the extension ".oldinfo", otherwise
  232.             delete them.
  233.  QUIET   -- Don't output the icons being converted.
  234.  GUI     -- Open the GUI interface with the settings from the command line.
  235.  
  236.  
  237. IconConvert can be made resident.
  238.  
  239.  
  240.     Bugs
  241.  
  242. It's not a bug, but if IconConvert runs out of memory when adding icons to
  243. the list or during conversion, it will just skip this icon  without
  244. notifying the user.
  245.  
  246.  
  247.     To Do
  248.  
  249.  * Improve colour conversion. Maybe an option to produce dithered colours?
  250.  
  251.  * Open a screen, so IconConvert can show the colours instead of just the
  252.    red/green/blue values in the palette windows.
  253.  
  254.  * On line help.
  255.  
  256.  * Localization.
  257.  
  258. 16.    Version History
  259.  
  260.  
  261.     Version History
  262.     ~~~~~~~~~~~~~~~
  263.  
  264. **** 1.1 (8 Nov. 1995) ****
  265.  
  266. This is so embarrassing -- obviously I hadn't bugtested IconConvert enough.
  267. I also forgot to document the AppWindow function, but that's alright because
  268. it didn't work...
  269.  
  270. Bug fixes:
  271.  
  272. * Icons dropped on the main window or choosed at start from the Workbench
  273.   had the wrong path (drawers were alright though.)
  274.  
  275. * Memory loss in the colour conversion routine.
  276.  
  277.  
  278. **** 1.0 (3 Nov. 1995) ****
  279.  
  280. Initital release.
  281.  
  282.  
  283.     Contacting the Author
  284.  
  285. I'd be glad to hear from you -- bugs, ideas, constructive criticism,
  286. whatever!
  287.  
  288. My address is:
  289.  
  290.     Peter Liljenberg
  291.     Tjureda 823 B
  292.     S-360 40 Rottne
  293.     Sweden
  294.  
  295. This address should be valid until July 1996.
  296.  
  297.  
  298. E-mail:
  299.  
  300.     dan.eriksson@vxjkatedral.se (lipnv3c, Peter Liljenberg)
  301.  
  302. N.B. Don't forget the part in the brackets, remember at least 'lipnv3c'.
  303.  
  304. This address may change in January 1996, and is definitly not valid after
  305. May 1996.
  306.